doc: add test reporter event lifecycle diagram#63780
Open
Han5991 wants to merge 1 commit into
Open
Conversation
Document the lifecycle of node:test reporter events under Class: TestsStream, with an ASCII diagram that distinguishes declaration-order events from their execution-order twins (test:dequeue/test:complete), the leaf vs suite flow, and the run-level finale. Fixes: nodejs#51908 Signed-off-by: sangwook <rewq5991@gmail.com>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
atlowChemi
approved these changes
Jun 8, 2026
| * `'test:stdout'` and `'test:stderr'` are emitted only when the [`--test`][] | ||
| flag is used, and are not guaranteed to follow declaration order. | ||
| * `'test:interrupted'` is emitted if the run is interrupted by a `SIGINT` | ||
| signal (for example, <kbd>Ctrl</kbd>+<kbd>C</kbd>). |
Member
There was a problem hiding this comment.
Not sure this will work, I recall seeing an issue with anchor tag recently (related to the new parser or something around those lines)
@avivkeller would you know?
Member
|
Ping @MoLow |
This comment was marked as spam.
This comment was marked as spam.
Gasila5
reviewed
Jun 8, 2026
Gasila5
left a comment
Gasila5
left a comment
There was a problem hiding this comment.
CB1qqYm9vZpdzaLHdY76S3rascQ78S1k2bnQESbuDWhH
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an "Event lifecycle" section under
Class: TestsStreamwith an ASCII diagram showing how reporter events relate: declaration-order events vs their execution-order twins (test:dequeue/test:complete), the leaf vs suite flow, and the run-level finale.Fixes: #51908